DATA MODEL DEFINITION |
|
| Data Type | Base Type | Description |
|---|
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-106a7] | TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013. |
For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 2.99, then it will indicate support for version 2.99. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| Device. | object | - | The top-level object for a Device. | - | 2.0 |
| X_oneM2M_CSENumberOfEntries | unsignedInt | - | The number of entries in the X_oneM2M_CSE table. | - | 2.99 |
| Device.DeviceInfo. | object | - | This object contains general device information. | - | 2.0 |
| Device.DeviceInfo.X_oneM2M_BatteryStatus. | object | - | This object status of the batteries on the device. | - | 2.99 |
| BatteryNumberOfEntries | unsignedInt | - | The number of entries in the Battery table. | - | 2.99 |
| Device.DeviceInfo.X_oneM2M_BatteryStatus.Battery.{i}. | object | - | This object represents information that the device has obtained via sampling the battery instance.
At most one entry in this table can exist with a given value for Alias. |
- | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Level | string | - | The current battery level. | - | 2.99 |
| Status | string | - | Current status of the battery. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}. | object | W | This object represents an instance of a Common Service Entity (CSE) for a M2M device or gateway. The X_oneM2M_CSE MAY be maintained by the ACS or by the CPE. When the X_oneM2M_CSE provides the administration of an CSE that is represented as a SoftwareModules.ExecutionUnit the X_oneM2M_CSE is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter. Clause 6.2.9 of the oneM2M Functional Architecture [ONEM2MFA] describes the high level description for CSE registration. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| CMDHPolicySetNumberOfEntries | unsignedInt | - | The number of entries in the CMDHPolicySet table. | - | 2.99 |
| M2MAreaNetworkNumberOfEntries | unsignedInt | - | The number of entries in the M2MAreaNetwork table. | - | 2.99 |
| M2MAreaNetworkDeviceNumberOfEntries | unsignedInt | - | The number of entries in the M2MAreaNetworkDevice table. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}. | object | W | This object describes the parameters necessary to administer the Communication Management and Delivery Handling (CMDH) handling policies applied to requests to access remotely hosted resources. Policies are described by instances of CMDHPolicySet. Which instances of CMDHPolicySet are used by the CSE is determined by the PolicyScope parameter. Annex D.x of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH processing. There is at most one CMDHPolicySet instance with the PolicyScope containing a specific application id (APP-ID) URI value within the list. There is exactly one CMDHPolicySet instance with a PolicyScope value of "default".
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| PolicyScope | string | W | Comma-separated list of strings. The parameter defines the scope of the policies contained in this instance of a CMDHPolicySet. The parameter value is:
When this parameter is set to a list of application id (APP-ID) URIs [RFC3986], the scope indicates that the policies are applicable to requests coming from any specific application on that list. When this parameter is set to a string with the value "default", the scope indicates that the policies are the default policies for this X_oneM2M_CSE instance. When this parameter is set to an empty string, the value represents an unknown CMDHPolicySet and the CMDHPolicySet is not to be used. |
<Empty> | 2.99 |
| ANPPolicyNumberOfEntries | unsignedInt | - | The number of entries in the ANPPolicy table. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.ANPPolicy.{i}. | object | W | This table contains the CMDH-handling policies which are controlled by the Access Network Provider(s). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ANName. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| ANName | string | W | This parameter is the name of the access network provider and used to determine for which access network the policies defined in the ANPPolicy table will apply. | <Empty> | 2.99 |
| BlockPeriodNumberOfEntries | unsignedInt | - | The number of entries in the BlockPeriod table. | - | 2.99 |
| RequestCategoryNumberOfEntries | unsignedInt | - | The number of entries in the RequestCategory table. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.ANPPolicy.{i}.BlockPeriod.{i}. | object | W | This table contains a list of block periods for a ANPPolicy. A block period defines how long the device will wait before re-trying to establish connectivity via the access network after the previous attempt has failed.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for FailedAttempts. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| FailedAttempts | unsignedInt | W | Number of consecutively failed access attempts for which the BlockDuration will be used to block the next access attempt. The CSE will apply the BlockPeriod entry with the largest number of consecutive failed attempts that is smaller or equal to the actual number of consecutive failed attempts. |
0 | 2.99 |
| BlockDuration | int | W | The duration, in seconds, to which to block further access attempts. | 0 | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}. | object | W | This table contains the Request Category (RCAT) policy items for defining when it is appropriate to use the access network for processing requests.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RCAT. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| RCAT | string | W | An RCAT is a string that represents a request category used for policy enforcement. | - | 2.99 |
| ScheduleNumberOfEntries | unsignedInt | - | The number of entries in the Schedule table. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}. | object | W | This table contains the schedules that define when it is appropriate to use the access network for processing requests for the specified value of the RCAT. The combination of all instances of the AbsTimeSpan along with the Schedules parameter makes up the complete schedule for this instance of a Schedule. The Schedules parameter defines a recurrence of the schedule. If instances of AbsTimeSpan exist, these instances places constraints on the schedule recurrence. If the value of the Schedules parameter is an empty string, at least one enabled instance of AbsTimeSpan MUST exist. Processing behavior for the use of RCAT Schedules is defined in clause x.x.x of the M2M Protocol Specification [ONEM2MProtocol] document.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| Schedules | string | W | Comma-separated list of strings. The list is a set of schedule strings. A schedule string is formatted according to the date and time fields defined CRONTAB input file definition in [POSIXBase]. The Schedules parameter is used to set the recurrence of the schedule. The timezone used for this parameter is dependent upon the existence of instances of AbsTimeSpan for this Schedule. If instances of AbsTimeSpan exist, then the timezone of the AbsTimeSpan is used otherwise the UTC timezone is used for this Schedules parameter. Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in [Section 3.2.3/TR-106a5] Example of CRONTAB string:
|
<Empty> | 2.99 |
| AbsTimeSpanNumberOfEntries | unsignedInt | - | The number of entries in the AbsTimeSpan table. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}.AbsTimeSpan.{i}. | object | W | This object defines an instance of a time span used for determining an RCAT schedule. An instance of the AbsTimeSpan represents the time span in which the schedule recurrence defined in Schedules is constrained. AbsTimeSpan instances with unknown values for the StartTime or EndTime are ignored. All instances of the AbsTimeSpan within this Schedule MUST utilize the same time zone.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| StartTime | dateTime | W | Date and time that represents the start of the time span. The value 0001-01-01T00:00:00Z represents an unknown value. The device MUST reject requests to set the StartTime value greater than the EndTime value. |
0001-01-01T00:00:00Z | 2.99 |
| EndTime | dateTime | W | Date and time that represents the end of the time span. The value 9999-12-31T23:59:59Z represents an infinite time span from the start time. The value 0001-01-01T00:00:00Z represents an unknown value. The device MUST reject requests to set the EndTime value less than or equal the StartTime value. |
0001-01-01T00:00:00Z | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.M2MSPPolicy. | object | - | This object maintains the CMDH handling policies' properties that are controlled by the M2M service provider for a request. | - | 2.99 |
| DefaultRCATValue | string | W | The default RCAT value to use for requests to remotely hosted resources during CMDH-handling when no RCAT value was specified in the request. | <Empty> | 2.99 |
| RequestCategoryNumberOfEntries | unsignedInt | - | The number of entries in the RequestCategory table. | - | 2.99 |
| Device.X_oneM2M_CSE.{i}.CMDHPolicySet.{i}.M2MSPPolicy.RequestCategory.{i}. | object | W | This object maintains a list of properties to be used for forwarding requests with a specified RCAT. Processing behavior for the use of M2M Service Provider policies is defined in clause x.x.x of the M2M Protocol Specification [ONEM2MProtocol] document.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RCAT. |
- | 2.99 |
| Enable | boolean | W | Administratively enables or disables this instance. | false | 2.99 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 2.99 |
| RCAT | string | W | An RCAT is a string that represents a request category used for policy enforcement. | - | 2.99 |
| TolerableDelay | int[-1:] | W | The tolerable duration, in seconds, that a request of the given RCAT category can be pending in CMDH handling when a request from an M2M Application does not specify a tolerable delay. A value of -1 represents an infinite duration. |
0 | 2.99 |
| Thresh | unsignedInt | W | The threshold of maximum number of pending requests permitted to be held for a specified RCAT. A value of 0 indicates that the request should be transmitted immediately. |
0 | 2.99 |
| Mem | string | W | This parameter defines the maximum size of the request queue for pending requests permitted to be held for a specified RCAT. The format of the string is an integer with an appended memory unit (B - Bytes, K - 1024 Bytes, M - 1048576 Bytes, G -1073741824, T - 1099511627776 Bytes). When the value is an empty string the memory threshold criteria for the associated RCATList will be ignored in CMDH handling.
|
- | 2.99 |
| RankedANList | string | W | Comma-separated list of strings. Each list item MUST be the path name of a row in the ANPPolicy table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The list is a prioritized set of Access Networks where the preference of using an Access Network is based on order of the list items with the lowest order list item as the most preferred Access Network. | <Empty> | 2.99 |
| Device.X_oneM2M_CSE.{i}.M2MAreaNetwork.{i}. | object | - | The M2M Area Network information provides administration capabilities for remote management of Application Dedicated Nodes (ADN) and devices in the M2M Network that are attached to this X_oneM2M_CSE instance. This object provides the administration of the properties needed by the CSE to remotely manage ADN and devices in the M2M Network within a specific type of M2M Area network as defined by Type. Multiple instances of M2MAreaNetwork with the same Type is permitted.
At most one entry in this table can exist with a given value for ID. |
- | 2.99 |
| ID | string | - | URI [RFC3986] that represents the identifier of the instance. | - | 2.99 |
| Type | string | - | ADN and devices in the M2M Network that connect to an CSE are said to be "attached devices" and are organized by M2M Area Networks within the X_oneM2M_CSE instance. The Type is an implementation-chosen string that indicates the type of M2M Area Network. | - | 2.99 |
| Devices | string | - | Comma-separated list of strings. Each list item MUST be the path name of a row in the M2MAreaNetworkDevice table, or an empty string. The list represents the ADN and devices in the M2M Network that are attached to this X_oneM2M_CSE instance that are within this M2MAreaNetwork instance. The list does not contain an instance for this CPE. |
- | 2.99 |
| Device.X_oneM2M_CSE.{i}.M2MAreaNetworkDevice.{i}. | object | - | This object provides the administration capability to the CSE for maintenance of ADN and devices in the M2M Network that are attached to this X_oneM2M_CSE instance. While discovery and identification of devices by the M2M Gateway or Device (CPE) is implementation specific, each device is represented by an instance of the Hosts.Host table. When the ADN or a device in the M2M Network is managed by the CWMP endpoint of the CPE, the M2MAreaNetworkDevice is expected to be referenced by an instance of one of the following tables:
This object instance provides the administration properties required by a CSE to remotely manage an instance of a ADN or a device in the M2M Network within a M2M area network. A ADN or a device in the M2M Network is associated with an instance of a M2MAreaNetwork. This table contains parameters and information of the ADN or a device in the M2M Network related to each M2MAreaNetwork instance. Instances of this table are created and deleted by the CPE. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device. |
- | 2.99 |
| M2MAreaNetwork | string | - | The value MUST be the path name of a row in the M2MAreaNetwork table. | - | 2.99 |
| Host | string | - | Comma-separated list of strings. Each list item MUST be the path name of the Hosts.Host table entry that represents an active or inactive ADN or a device in the M2M Network. If the referenced object is deleted, the corresponding item MUST be removed from the list. | - | 2.99 |
| Type | string | - | The type of that device that indicates the functions or services provided by the ADN or a device in the M2M Network. Examples include temperature sensor, actuator, Zigbee coordinator or Zigbee router. | - | 2.99 |
| Neighbors | string | - | Comma-separated list of strings. Each list item MUST be the path name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that represent the reachable neighbors of this ADN or a device in the M2M Network. | - | 2.99 |
| SleepInterval | unsignedInt | W | The interval, in seconds, between sleep periods for the device. A value of 0 represents a device that does not sleep. Note: When this value is modified, the CPE could modify the SleepInterval for this ADN or a device in the M2M Network in other M2M Area Networks. |
- | 2.99 |
| SleepDuration | unsignedInt | W | The duration, in seconds, of a sleep period. The value 0 represents an unknown value. Note: When this value is modified, the CPE could modify the SleepDuration for this ADN or a device in the M2M Network in other M2M Area Networks. |
- | 2.99 |
| Status | string | - | The sleep status of the device. Enumeration of:
|
- | 2.99 |
| Active | boolean | - | Whether or not this M2M Device is currently attached to this X_oneM2M_CSE instance. The ability to list inactive a ADN or device in the M2M Network is OPTIONAL. If the CPE includes inactive ADNs and devices in the M2M Network in this table, Active is set to false for each inactive ADN or device in the M2M Network. The length of time an inactive ADN or device in the M2M Network remains listed in this table is a local matter to the CPE. |
- | 2.99 |
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Abbreviation | Description |
|---|---|
| R | Read support is REQUIRED. |
| W | Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only. |
| P | The object is REQUIRED to be present. |
| C | Creation and deletion of instances of the object via AddObject and DeleteObject is REQUIRED. |
| A | Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED. |
| D | Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED. |